home *** CD-ROM | disk | FTP | other *** search
/ Apple Developer Connection 1998 Fall: Game Toolkit / Disc.iso / SDKs / QuickTime Mac / AIncludes / QD3DGroup.a < prev    next >
Encoding:
Text File  |  1998-04-09  |  13.4 KB  |  462 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        QD3DGroup.a
  3. ;
  4. ;    Contains:    Q3Group methods        
  5. ;
  6. ;    Version:    Technology:    Quickdraw 3D 1.5.4
  7. ;                Release:    QuickTime 3.0
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__QD3DGROUP__') = 'UNDEFINED' THEN
  19. __QD3DGROUP__ SET 1
  20.  
  21.     IF &TYPE('__QD3D__') = 'UNDEFINED' THEN
  22.     include 'QD3D.a'
  23.     ENDIF
  24.  
  25. ; ******************************************************************************
  26. ; **                                                                             **
  27. ; **                            Group Typedefs                                     **
  28. ; **                                                                             **
  29. ; ****************************************************************************
  30.  
  31. ; 
  32. ; * These flags affect how a group is traversed
  33. ; * They apply to when a group is "drawn", "picked", "bounded", "written"
  34. ; 
  35.  
  36.  
  37. ; typedef long                            TQ3DisplayGroupStateMasks
  38. kQ3DisplayGroupStateNone        EQU        0
  39. kQ3DisplayGroupStateMaskIsDrawn    EQU        $01
  40. kQ3DisplayGroupStateMaskIsInline EQU    $02
  41. kQ3DisplayGroupStateMaskUseBoundingBox EQU $04
  42. kQ3DisplayGroupStateMaskUseBoundingSphere EQU $08
  43. kQ3DisplayGroupStateMaskIsPicked EQU    $10
  44. kQ3DisplayGroupStateMaskIsWritten EQU    $20
  45. ; typedef unsigned long                 TQ3DisplayGroupState
  46.  
  47. ; ******************************************************************************
  48. ; **                                                                             **
  49. ; **                    Group Routines (apply to all groups)                     **
  50. ; **                                                                             **
  51. ; ****************************************************************************
  52.  
  53. ;
  54. ; extern TQ3GroupObject Q3Group_New(void )
  55. ;
  56.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  57.         IMPORT_CFM_FUNCTION Q3Group_New
  58.     ENDIF
  59.  
  60. ;
  61. ; extern TQ3ObjectType Q3Group_GetType(TQ3GroupObject group)
  62. ;
  63.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  64.         IMPORT_CFM_FUNCTION Q3Group_GetType
  65.     ENDIF
  66.  
  67. ;
  68. ; extern TQ3GroupPosition Q3Group_AddObject(TQ3GroupObject group, TQ3Object object)
  69. ;
  70.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  71.         IMPORT_CFM_FUNCTION Q3Group_AddObject
  72.     ENDIF
  73.  
  74. ;
  75. ; extern TQ3GroupPosition Q3Group_AddObjectBefore(TQ3GroupObject group, TQ3GroupPosition position, TQ3Object object)
  76. ;
  77.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  78.         IMPORT_CFM_FUNCTION Q3Group_AddObjectBefore
  79.     ENDIF
  80.  
  81. ;
  82. ; extern TQ3GroupPosition Q3Group_AddObjectAfter(TQ3GroupObject group, TQ3GroupPosition position, TQ3Object object)
  83. ;
  84.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  85.         IMPORT_CFM_FUNCTION Q3Group_AddObjectAfter
  86.     ENDIF
  87.  
  88. ;
  89. ; extern TQ3Status Q3Group_GetPositionObject(TQ3GroupObject group, TQ3GroupPosition position, TQ3Object *object)
  90. ;
  91.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  92.         IMPORT_CFM_FUNCTION Q3Group_GetPositionObject
  93.     ENDIF
  94.  
  95. ;
  96. ; extern TQ3Status Q3Group_SetPositionObject(TQ3GroupObject group, TQ3GroupPosition position, TQ3Object object)
  97. ;
  98.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  99.         IMPORT_CFM_FUNCTION Q3Group_SetPositionObject
  100.     ENDIF
  101.  
  102. ;
  103. ; extern TQ3Object Q3Group_RemovePosition(TQ3GroupObject group, TQ3GroupPosition position)
  104. ;
  105.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  106.         IMPORT_CFM_FUNCTION Q3Group_RemovePosition
  107.     ENDIF
  108.  
  109. ;
  110. ; extern TQ3Status Q3Group_GetFirstPosition(TQ3GroupObject group, TQ3GroupPosition *position)
  111. ;
  112.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  113.         IMPORT_CFM_FUNCTION Q3Group_GetFirstPosition
  114.     ENDIF
  115.  
  116. ;
  117. ; extern TQ3Status Q3Group_GetLastPosition(TQ3GroupObject group, TQ3GroupPosition *position)
  118. ;
  119.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  120.         IMPORT_CFM_FUNCTION Q3Group_GetLastPosition
  121.     ENDIF
  122.  
  123. ;
  124. ; extern TQ3Status Q3Group_GetNextPosition(TQ3GroupObject group, TQ3GroupPosition *position)
  125. ;
  126.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  127.         IMPORT_CFM_FUNCTION Q3Group_GetNextPosition
  128.     ENDIF
  129.  
  130. ;
  131. ; extern TQ3Status Q3Group_GetPreviousPosition(TQ3GroupObject group, TQ3GroupPosition *position)
  132. ;
  133.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  134.         IMPORT_CFM_FUNCTION Q3Group_GetPreviousPosition
  135.     ENDIF
  136.  
  137. ;
  138. ; extern TQ3Status Q3Group_CountObjects(TQ3GroupObject group, unsigned long *nObjects)
  139. ;
  140.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  141.         IMPORT_CFM_FUNCTION Q3Group_CountObjects
  142.     ENDIF
  143.  
  144. ;
  145. ; extern TQ3Status Q3Group_EmptyObjects(TQ3GroupObject group)
  146. ;
  147.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  148.         IMPORT_CFM_FUNCTION Q3Group_EmptyObjects
  149.     ENDIF
  150.  
  151. ; 
  152. ; *     Typed Access
  153. ; 
  154.  
  155. ;
  156. ; extern TQ3Status Q3Group_GetFirstPositionOfType(TQ3GroupObject group, TQ3ObjectType isType, TQ3GroupPosition *position)
  157. ;
  158.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  159.         IMPORT_CFM_FUNCTION Q3Group_GetFirstPositionOfType
  160.     ENDIF
  161.  
  162. ;
  163. ; extern TQ3Status Q3Group_GetLastPositionOfType(TQ3GroupObject group, TQ3ObjectType isType, TQ3GroupPosition *position)
  164. ;
  165.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  166.         IMPORT_CFM_FUNCTION Q3Group_GetLastPositionOfType
  167.     ENDIF
  168.  
  169. ;
  170. ; extern TQ3Status Q3Group_GetNextPositionOfType(TQ3GroupObject group, TQ3ObjectType isType, TQ3GroupPosition *position)
  171. ;
  172.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  173.         IMPORT_CFM_FUNCTION Q3Group_GetNextPositionOfType
  174.     ENDIF
  175.  
  176. ;
  177. ; extern TQ3Status Q3Group_GetPreviousPositionOfType(TQ3GroupObject group, TQ3ObjectType isType, TQ3GroupPosition *position)
  178. ;
  179.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  180.         IMPORT_CFM_FUNCTION Q3Group_GetPreviousPositionOfType
  181.     ENDIF
  182.  
  183. ;
  184. ; extern TQ3Status Q3Group_CountObjectsOfType(TQ3GroupObject group, TQ3ObjectType isType, unsigned long *nObjects)
  185. ;
  186.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  187.         IMPORT_CFM_FUNCTION Q3Group_CountObjectsOfType
  188.     ENDIF
  189.  
  190. ;
  191. ; extern TQ3Status Q3Group_EmptyObjectsOfType(TQ3GroupObject group, TQ3ObjectType isType)
  192. ;
  193.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  194.         IMPORT_CFM_FUNCTION Q3Group_EmptyObjectsOfType
  195.     ENDIF
  196.  
  197. ; 
  198. ; *    Determine position of objects in a group
  199. ; 
  200.  
  201. ;
  202. ; extern TQ3Status Q3Group_GetFirstObjectPosition(TQ3GroupObject group, TQ3Object object, TQ3GroupPosition *position)
  203. ;
  204.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  205.         IMPORT_CFM_FUNCTION Q3Group_GetFirstObjectPosition
  206.     ENDIF
  207.  
  208. ;
  209. ; extern TQ3Status Q3Group_GetLastObjectPosition(TQ3GroupObject group, TQ3Object object, TQ3GroupPosition *position)
  210. ;
  211.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  212.         IMPORT_CFM_FUNCTION Q3Group_GetLastObjectPosition
  213.     ENDIF
  214.  
  215. ;
  216. ; extern TQ3Status Q3Group_GetNextObjectPosition(TQ3GroupObject group, TQ3Object object, TQ3GroupPosition *position)
  217. ;
  218.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  219.         IMPORT_CFM_FUNCTION Q3Group_GetNextObjectPosition
  220.     ENDIF
  221.  
  222. ;
  223. ; extern TQ3Status Q3Group_GetPreviousObjectPosition(TQ3GroupObject group, TQ3Object object, TQ3GroupPosition *position)
  224. ;
  225.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  226.         IMPORT_CFM_FUNCTION Q3Group_GetPreviousObjectPosition
  227.     ENDIF
  228.  
  229.  
  230. ; ******************************************************************************
  231. ; **                                                                             **
  232. ; **                            Group Subclasses                                 **
  233. ; **                                                                             **
  234. ; ****************************************************************************
  235.  
  236. ;
  237. ; extern TQ3GroupObject Q3LightGroup_New(void )
  238. ;
  239.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  240.         IMPORT_CFM_FUNCTION Q3LightGroup_New
  241.     ENDIF
  242.  
  243. ;
  244. ; extern TQ3GroupObject Q3InfoGroup_New(void )
  245. ;
  246.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  247.         IMPORT_CFM_FUNCTION Q3InfoGroup_New
  248.     ENDIF
  249.  
  250. ; ******************************************************************************
  251. ; **                                                                             **
  252. ; **                        Display Group Routines                                 **
  253. ; **                                                                             **
  254. ; ****************************************************************************
  255.  
  256. ;
  257. ; extern TQ3GroupObject Q3DisplayGroup_New(void )
  258. ;
  259.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  260.         IMPORT_CFM_FUNCTION Q3DisplayGroup_New
  261.     ENDIF
  262.  
  263. ;
  264. ; extern TQ3ObjectType Q3DisplayGroup_GetType(TQ3GroupObject group)
  265. ;
  266.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  267.         IMPORT_CFM_FUNCTION Q3DisplayGroup_GetType
  268.     ENDIF
  269.  
  270. ;
  271. ; extern TQ3Status Q3DisplayGroup_GetState(TQ3GroupObject group, TQ3DisplayGroupState *state)
  272. ;
  273.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  274.         IMPORT_CFM_FUNCTION Q3DisplayGroup_GetState
  275.     ENDIF
  276.  
  277. ;
  278. ; extern TQ3Status Q3DisplayGroup_SetState(TQ3GroupObject group, TQ3DisplayGroupState state)
  279. ;
  280.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  281.         IMPORT_CFM_FUNCTION Q3DisplayGroup_SetState
  282.     ENDIF
  283.  
  284. ;
  285. ; extern TQ3Status Q3DisplayGroup_Submit(TQ3GroupObject group, TQ3ViewObject view)
  286. ;
  287.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  288.         IMPORT_CFM_FUNCTION Q3DisplayGroup_Submit
  289.     ENDIF
  290.  
  291. ; ******************************************************************************
  292. ; **                                                                             **
  293. ; **        Ordered Display Group                                                  **
  294. ; **                                                                             **
  295. ; **        Ordered display groups keep objects in order by the type of object:     **
  296. ; **                                                                             **
  297. ; **        1    kQ3ShapeTypeTransform                                             **
  298. ; **        2    kQ3ShapeTypeStyle                                                  **
  299. ; **        3    kQ3SetTypeAttribute                                                  **
  300. ; **        4    kQ3ShapeTypeShader                                                  **
  301. ; **        5    kQ3ShapeTypeCamera                                                  **
  302. ; **        6    kQ3ShapeTypeLight                                                  **
  303. ; **        7    kQ3ShapeTypeGeometry                                             **
  304. ; **        8    kQ3ShapeTypeGroup                                                 **            
  305. ; **        9    kQ3ShapeTypeUnknown                                                 **
  306. ; **                                                                             **
  307. ; **        Within a type, you are responsible for keeping things in order.         **
  308. ; **                                                                             **
  309. ; **        You may access and/or manipulate the group using the above types      **
  310. ; **        (fast), or you may use any parent or leaf class types (slower).         **
  311. ; **                                                                             **
  312. ; **        Additional types will be added as functionality grows.                 **
  313. ; **                                                                             **
  314. ; **        The group calls which access by type are much faster for ordered     ** 
  315. ; **        display group for the types above.                                     **
  316. ; **                                                                             **
  317. ; **        N.B. In QuickDraw 3D 1.0 Lights and Cameras are a no-op when drawn.     **
  318. ; **                                                                             **
  319. ; ****************************************************************************
  320.  
  321. ;
  322. ; extern TQ3GroupObject Q3OrderedDisplayGroup_New(void )
  323. ;
  324.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  325.         IMPORT_CFM_FUNCTION Q3OrderedDisplayGroup_New
  326.     ENDIF
  327.  
  328. ; ******************************************************************************
  329. ; **                                                                             **
  330. ; **        IO Proxy Display Group                                                  **
  331. ; **                                                                             **
  332. ; **        IO Proxy display groups are used to place more than one              **
  333. ; **        representation of an object in a metafile. For example, if you know     **
  334. ; **        another program does not understand NURBPatches but does understand  **
  335. ; **        Meshes, you may place a mesh and a NURB Patch in an IO Proxy Group,  **
  336. ; **        and the reading program will select the desired representation.         **
  337. ; **                                                                             **
  338. ; **        Objects in an IO Proxy Display Group are placed in their preferencial**
  339. ; **        order, with the FIRST object being the MOST preferred, the LAST      **
  340. ; **        object the least preferred.                                             **
  341. ; **                                                                             **
  342. ; **        The behavior of an IO Proxy Display Group is that when drawn/picked/ **
  343. ; **        bounded, the first object in the group that is not "Unknown" is used,**
  344. ; **        and the other objects ignored.                                         **
  345. ; **                                                                             **
  346. ; ****************************************************************************
  347.  
  348. ;
  349. ; extern TQ3GroupObject Q3IOProxyDisplayGroup_New(void )
  350. ;
  351.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  352.         IMPORT_CFM_FUNCTION Q3IOProxyDisplayGroup_New
  353.     ENDIF
  354.  
  355. ; ******************************************************************************
  356. ; **                                                                             **
  357. ; **                        Group Extension Definitions                             **
  358. ; **                                                                             **
  359. ; ****************************************************************************
  360.  
  361. ; 
  362. ; *    Searching methods - OPTIONAL
  363. ; 
  364.  
  365.  
  366. kQ3XMethodType_GroupAcceptObject EQU    'gaco'
  367.  
  368. kQ3XMethodType_GroupAddObject    EQU        'gado'
  369.  
  370. kQ3XMethodType_GroupAddObjectBefore EQU    'gaob'
  371.  
  372. kQ3XMethodType_GroupAddObjectAfter EQU    'gaoa'
  373.  
  374. kQ3XMethodType_GroupSetPositionObject EQU 'gspo'
  375.  
  376. kQ3XMethodType_GroupRemovePosition EQU    'grmp'
  377. ; 
  378. ; *    Searching methods - OPTIONAL - default uses above methods
  379. ; 
  380.  
  381.  
  382. kQ3XMethodType_GroupGetFirstPositionOfType EQU 'gfrt'
  383.  
  384. kQ3XMethodType_GroupGetLastPositionOfType EQU 'glst'
  385.  
  386. kQ3XMethodType_GroupGetNextPositionOfType EQU 'gnxt'
  387.  
  388. kQ3XMethodType_GroupGetPrevPositionOfType EQU 'gpvt'
  389.  
  390. kQ3XMethodType_GroupCountObjectsOfType EQU 'gcnt'
  391.  
  392. kQ3XMethodType_GroupEmptyObjectsOfType EQU 'geot'
  393.  
  394. kQ3XMethodType_GroupGetFirstObjectPosition EQU 'gfop'
  395.  
  396. kQ3XMethodType_GroupGetLastObjectPosition EQU 'glop'
  397.  
  398. kQ3XMethodType_GroupGetNextObjectPosition EQU 'gnop'
  399.  
  400. kQ3XMethodType_GroupGetPrevObjectPosition EQU 'gpop'
  401. ; 
  402. ; *    Group Position Methods
  403. ; *    
  404. ; 
  405.  
  406.  
  407. kQ3XMethodType_GroupPositionSize EQU    'ggpz'
  408. ; typedef unsigned long                 TQ3XMethodTypeGroupPositionSize
  409.  
  410.  
  411. kQ3XMethodType_GroupPositionNew    EQU        'ggpn'
  412.  
  413. kQ3XMethodType_GroupPositionCopy EQU    'ggpc'
  414.  
  415. kQ3XMethodType_GroupPositionDelete EQU    'ggpd'
  416. ; 
  417. ; *    View Drawing Helpers
  418. ; *    
  419. ; *    TQ3XGroupStartIterateMethod
  420. ; *
  421. ; *        Pass back *object = NULL to NOT call EndIterate iterate
  422. ; *        Pass back *object != NULL to draw object
  423. ; *         (other side will pass it to EndIterate for deletion!)
  424. ; *
  425. ; *        *iterator is uninitialized, use for iteration state. Caller should 
  426. ; *         ignore it.
  427. ; *    
  428. ; *    TQ3XGroupEndIterateMethod
  429. ; *    
  430. ; *        *object is previous object, dispose it or play with it.
  431. ; *        Pass back NULL when last iteration has occurred
  432. ; *        *iterator is previous value, use for iteration state Caller should 
  433. ; *        ignore it.
  434. ; 
  435.  
  436.  
  437. kQ3XMethodType_GroupStartIterate EQU    'gstd'
  438.  
  439. kQ3XMethodType_GroupEndIterate    EQU        'gitd'
  440. ; 
  441. ; *    IO  Helpers
  442. ; *    
  443. ; *    TQ3XGroupEndReadMethod
  444. ; *        Called when a group has been completely read. Group should perform
  445. ; *        validation and clean up any reading caches.
  446. ; 
  447.  
  448.  
  449. kQ3XMethodType_GroupEndRead        EQU        'gerd'
  450. ;
  451. ; extern void *Q3XGroup_GetPositionPrivate(TQ3GroupObject group, TQ3GroupPosition position)
  452. ;
  453.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  454.         IMPORT_CFM_FUNCTION Q3XGroup_GetPositionPrivate
  455.     ENDIF
  456.  
  457.  
  458.  
  459.  
  460.     ENDIF ; __QD3DGROUP__ 
  461.  
  462.